/*
 * Copyright 2011 Kevin Seim
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.beanio.internal.parser;

import java.util.Set;

import org.beanio.internal.util.TreeNode;

/**
 * The base class for all nodes in the parser tree.  
 * 
 * @author Kevin Seim
 * @since 2.0
 */
public abstract class Component extends TreeNode<Component> {

    /**
     * Constructs a new <tt>Component</tt>.
     */
    public Component() {
        super();
    }

    /**
     * Constructs a new <tt>Component</tt>.
     * @param size the initial child capacity
     */
    public Component(int size) {
        super(size);
    }
    
    /**
     * Called by a stream to register variables stored in the parsing context.  This method
     * should be overridden by subclasses that need to register one or more parser context variables.
     * @param locals set of local variables
     */
    public void registerLocals(Set<ParserLocal<? extends Object>> locals) {
        for (Component c : getChildren()) {
            c.registerLocals(locals);
        }
    }
}
